Window handling. More...

#include <system/debug/kzs_error.h>
#include <system/kzs_types.h>
#include <system/display/kzs_surface_configuration.h>
#include <system/wrappers/kzs_math.h>
#include <system/kzs_header.h>

Data Structures
struct	KzsWindowProperties
	Properties for a window. More...

Macros
#define	KZS_WINDOW_POSITION_DEFAULT
	Platform-specific default position for a window. More...

Enumerations
enum	KzsWindowOrientationAngle { KZS_WINDOW_ORIENTATION_ANGLE_0, KZS_WINDOW_ORIENTATION_ANGLE_180 }
	List of window orientation angles. More...

enum	KzsWindowStyle { KZS_WINDOW_STYLE_FIXED, KZS_WINDOW_STYLE_RESIZABLE, KZS_WINDOW_STYLE_FULL_SCREEN, KZS_WINDOW_STYLE_BORDERLESS, KZS_WINDOW_STYLE_STUDIO_PREVIEW, KZS_WINDOW_STYLE_DEFAULT }
	Enumeration for different window styles. More...

Functions
kzsError	kzsWindowCreateFromNative (struct KzsWindowNative windowNative, struct KzsWindow *out_window)
	Creates a window with a previously created native window. More...

kzsError	kzsWindowCreate (const struct KzsDesktop desktop, const struct KzsDisplay display, const struct KzsWindowProperties windowPropertiesRequested, const struct KzsSurfaceConfiguration configuration, struct KzsWindow **out_window)
	Creates a window and returns it. More...

kzsError	kzsWindowDelete (struct KzsWindow *window)
	Deletes a window. More...

kzsError	kzsWindowResize (const struct KzsWindow *window, kzUint width, kzUint height)
	Resizes the window. More...

kzsError	kzsWindowSetPositionAbsolute (const struct KzsWindow *window, kzUint x, kzUint y)
	Sets the absolute position the window, if supported by the platform. More...

kzsError	kzsWindowShow (struct KzsWindow *window)
	Makes newly created window visible. More...

kzsError	kzsWindowSetTitle (const struct KzsWindow *window, kzString titleText)
	Sets the title bar string for the window, if supported by the platform. More...

kzUint	kzsWindowGetCurrentWidth (const struct KzsWindow *window)
	Gets the width of the window. More...

kzUint	kzsWindowGetCurrentHeight (const struct KzsWindow *window)
	Gets the height of the window. More...

struct KzsWindowNative *	kzsWindowGetNative (const struct KzsWindow *window)
	Gets the native window. More...

kzsError	kzsWindowNativeCreate (const struct KzsDesktop desktop, const struct KzsDisplay display, const struct KzsWindowProperties windowPropertiesRequested, const struct KzsSurfaceConfigurationNative configurationNative, struct KzsWindowProperties out_windowProperties, struct KzsWindowNative *out_windowNative)
	Creates a native window. More...

kzsError	kzsWindowNativeInitialize (struct KzsWindowNative windowNative, struct KzsWindow window)
	Initializes window. More...

kzsError	kzsWindowNativeDelete (struct KzsWindowNative *windowNative)
	Deletes a native window. More...

kzsError	kzsWindowNativeResize (const struct KzsWindowNative *windowNative, kzUint width, kzUint height)
	Resizes the window. More...

kzsError	kzsWindowNativeSetPositionAbsolute (const struct KzsWindowNative *windowNative, kzUint x, kzUint y)
	Sets the absolute position the window, if supported by the platform. More...

kzsError	kzsWindowNativeShow (struct KzsWindowNative *windowNative)
	Makes newly created window visible. More...

kzsError	kzsWindowNativeSetTitle (const struct KzsWindowNative *windowNative, kzString titleText)
	Sets the title bar string for the window, if supported by the platform. More...

kzUint	kzsWindowNativeGetCurrentWidth (const struct KzsWindowNative *windowNative)
	Gets the width of the window. More...

kzUint	kzsWindowNativeGetCurrentHeight (const struct KzsWindowNative *windowNative)
	Gets the height of the window. More...

kzsError	kzsWindowNativeSetOrder (const struct KzsWindowNative *windowNative, kzInt order)
	Sets the window Z order, if supported by the platform. More...

Detailed Description

Window handling.

Macro Definition Documentation

#define KZS_WINDOW_POSITION_DEFAULT

Platform-specific default position for a window.

Enumeration Type Documentation

enum KzsWindowOrientationAngle

List of window orientation angles.

Enumerator
KZS_WINDOW_ORIENTATION_ANGLE_0	0 degrees.
KZS_WINDOW_ORIENTATION_ANGLE_180	180 degrees.

enum KzsWindowStyle

Enumeration for different window styles.

Enumerator
KZS_WINDOW_STYLE_FIXED	A window that cannot be resized.
KZS_WINDOW_STYLE_RESIZABLE	A window that can be resized.
KZS_WINDOW_STYLE_FULL_SCREEN	Window occupies the whole screen.
KZS_WINDOW_STYLE_BORDERLESS	No borders or other decorations.
KZS_WINDOW_STYLE_STUDIO_PREVIEW	Docked window with external message handling. Should only be used by Kanzi Studio.
KZS_WINDOW_STYLE_DEFAULT	Let the system choose the appropriate window style for the platform.

Function Documentation

kzsError kzsWindowCreateFromNative	(	struct KzsWindowNative *	windowNative,
		struct KzsWindow **	out_window
	)

Creates a window with a previously created native window.

Takes ownership of the native window.

kzsError kzsWindowCreate	(	const struct KzsDesktop *	desktop,
		const struct KzsDisplay *	display,
		const struct KzsWindowProperties *	windowPropertiesRequested,
		const struct KzsSurfaceConfiguration *	configuration,
		struct KzsWindow **	out_window
	)

Creates a window and returns it.

kzsError kzsWindowDelete ( struct KzsWindow * window)

Deletes a window.

kzsError kzsWindowResize	(	const struct KzsWindow *	window,
		kzUint	width,
		kzUint	height
	)

Resizes the window.

kzsError kzsWindowSetPositionAbsolute	(	const struct KzsWindow *	window,
		kzUint	x,
		kzUint	y
	)

Sets the absolute position the window, if supported by the platform.

kzsError kzsWindowShow ( struct KzsWindow * window)

Makes newly created window visible.

kzsError kzsWindowSetTitle	(	const struct KzsWindow *	window,
		kzString	titleText
	)

Sets the title bar string for the window, if supported by the platform.

kzUint kzsWindowGetCurrentWidth ( const struct KzsWindow * window)

Gets the width of the window.

kzUint kzsWindowGetCurrentHeight ( const struct KzsWindow * window)

Gets the height of the window.

struct KzsWindowNative* kzsWindowGetNative ( const struct KzsWindow * window)

Gets the native window.

kzsError kzsWindowNativeCreate	(	const struct KzsDesktop *	desktop,
		const struct KzsDisplay *	display,
		const struct KzsWindowProperties *	windowPropertiesRequested,
		const struct KzsSurfaceConfigurationNative *	configurationNative,
		struct KzsWindowProperties *	out_windowProperties,
		struct KzsWindowNative **	out_windowNative
	)

Creates a native window.

kzsError kzsWindowNativeInitialize	(	struct KzsWindowNative *	windowNative,
		struct KzsWindow *	window
	)

Initializes window.

Called after creating window and native window.

kzsError kzsWindowNativeDelete ( struct KzsWindowNative * windowNative)

Deletes a native window.

kzsError kzsWindowNativeResize	(	const struct KzsWindowNative *	windowNative,
		kzUint	width,
		kzUint	height
	)

Resizes the window.

Native implementation.

kzsError kzsWindowNativeSetPositionAbsolute	(	const struct KzsWindowNative *	windowNative,
		kzUint	x,
		kzUint	y
	)

Sets the absolute position the window, if supported by the platform.

Native implementation.

kzsError kzsWindowNativeShow ( struct KzsWindowNative * windowNative)

Makes newly created window visible.

kzsError kzsWindowNativeSetTitle	(	const struct KzsWindowNative *	windowNative,
		kzString	titleText
	)

Sets the title bar string for the window, if supported by the platform.

Native implementation.

kzUint kzsWindowNativeGetCurrentWidth ( const struct KzsWindowNative * windowNative)

Gets the width of the window.

kzUint kzsWindowNativeGetCurrentHeight ( const struct KzsWindowNative * windowNative)

Gets the height of the window.

kzsError kzsWindowNativeSetOrder	(	const struct KzsWindowNative *	windowNative,
		kzInt	order
	)

Sets the window Z order, if supported by the platform.

Data Structures

Macros

Enumerations

Functions

Detailed Description

Macro Definition Documentation

Enumeration Type Documentation

Function Documentation